Skip to content

Add description to Marker#307

Merged
tusharmakkar08 merged 1 commit intoalecthomas:masterfrom
balloob:description
Oct 31, 2017
Merged

Add description to Marker#307
tusharmakkar08 merged 1 commit intoalecthomas:masterfrom
balloob:description

Conversation

@balloob
Copy link
Copy Markdown
Contributor

@balloob balloob commented Oct 31, 2017 •
edited
Loading

Add a description field to markers. Fixes #305.

import voluptuous as vol

SCHEMA = vol.Schema({
  vol.Required('name', description='The name of the user.'): str,
  vol.Required('age', description='The age of the user.'): int,
})

This will allow users to generate documentation by introspecting the schema.

I've started an introspection experiment here.

@coveralls
Copy link
Copy Markdown

coveralls commented Oct 31, 2017 •
edited
Loading

Coverage Status

Coverage increased (+0.005%) to 95.314% when pulling 6180781 on balloob:description into 48d1ea8 on alecthomas:master.

@tusharmakkar08 tusharmakkar08 merged commit 46dc265 into alecthomas:master Oct 31, 2017
@fabaff fabaff mentioned this pull request Nov 26, 2017
Closed
@balloob balloob deleted the description branch January 27, 2018 00:38
This was referenced Feb 15, 2018
Closed
Closed
Closed
Closed
Closed
@svisser svisser mentioned this pull request Feb 16, 2018
Merged
@balloob balloob mentioned this pull request Feb 16, 2018
Merged
This was referenced Feb 22, 2018
Closed
Closed
@spacegaier spacegaier mentioned this pull request Oct 16, 2022
Closed
@jonnylangefeld jonnylangefeld mentioned this pull request Jan 17, 2023
Closed
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tusharmakkar08 tusharmakkar08 tusharmakkar08 approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@balloob @coveralls @tusharmakkar08